11 require_once( 'WatchedItem.php' );
12 require_once( 'Group.php' );
14 # Number of characters in user_token field
15 define( 'USER_TOKEN_LENGTH', 32 );
25 var $mId, $mName, $mPassword, $mEmail, $mNewtalk;
26 var $mEmailAuthenticationtimestamp;
27 var $mRights, $mOptions;
28 var $mDataLoaded, $mNewpassword;
30 var $mBlockedby, $mBlockreason;
35 /** Array of group id the user belong to */
39 /** Construct using User:loadDefaults() */
41 $this->loadDefaults();
45 * Static factory method
47 * @param string $name Username, validated by Title:newFromText()
49 function newFromName( $name ) {
52 # Clean up name according to title rules
54 $t = Title
::newFromText( $name );
58 $u->setName( $t->getText() );
59 $u->setId( $u->idFromName( $t->getText() ) );
65 * Get username given an id.
66 * @param integer $id Database user id
67 * @return string Nickname of a user
70 function whoIs( $id ) {
71 $dbr =& wfGetDB( DB_SLAVE
);
72 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ) );
76 * Get real username given an id.
77 * @param integer $id Database user id
78 * @return string Realname of a user
81 function whoIsReal( $id ) {
82 $dbr =& wfGetDB( DB_SLAVE
);
83 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ) );
87 * Get database id given a user name
88 * @param string $name Nickname of a user
89 * @return integer|null Database user id (null: if non existent
92 function idFromName( $name ) {
93 $fname = "User::idFromName";
95 $nt = Title
::newFromText( $name );
96 if( is_null( $nt ) ) {
100 $dbr =& wfGetDB( DB_SLAVE
);
101 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), $fname );
103 if ( $s === false ) {
111 * does the string match an anonymous user IP address?
112 * @param string $name Nickname of a user
115 function isIP( $name ) {
116 return preg_match("/^\d{1,3}\.\d{1,3}.\d{1,3}\.\d{1,3}$/",$name);
120 * does the string match roughly an email address ?
121 * @param string $addr email address
124 function isValidEmailAddr ( $addr ) {
125 return preg_match( '/^([a-z0-9_.-]+([a-z0-9_.-]+)*\@[a-z0-9_-]+([a-z0-9_.-]+)*([a-z.]{2,})+)$/', strtolower($addr));
129 * probably return a random password
130 * @return string probably a random password
132 * @todo Check what is doing really [AV]
134 function randomPassword() {
135 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
136 $l = strlen( $pwchars ) - 1;
138 $np = $pwchars{mt_rand( 0, $l )} . $pwchars{mt_rand( 0, $l )} .
139 $pwchars{mt_rand( 0, $l )} . chr( mt_rand(48, 57) ) .
140 $pwchars{mt_rand( 0, $l )} . $pwchars{mt_rand( 0, $l )} .
141 $pwchars{mt_rand( 0, $l )};
146 * Set properties to default
147 * Used at construction. It will load per language default settings only
148 * if we have an available language object.
150 function loadDefaults() {
153 $fname = 'User::loadDefaults' . $n;
154 wfProfileIn( $fname );
156 global $wgContLang, $wgIP, $wgDBname;
157 global $wgNamespacesToBeSearchedDefault;
160 $this->mNewtalk
= -1;
161 $this->mName
= $wgIP;
162 $this->mRealName
= $this->mEmail
= '';
163 $this->mEmailAuthenticationtimestamp
= 0;
164 $this->mPassword
= $this->mNewpassword
= '';
165 $this->mRights
= array();
166 $this->mGroups
= array();
167 // Getting user defaults only if we have an available language
168 if( isset( $wgContLang ) ) {
169 $this->loadDefaultFromLanguage();
172 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
173 $this->mOptions
['searchNs'.$nsnum] = $val;
175 unset( $this->mSkin
);
176 $this->mDataLoaded
= false;
177 $this->mBlockedby
= -1; # Unset
178 $this->setToken(); # Random
179 $this->mHash
= false;
181 if ( isset( $_COOKIE[$wgDBname.'LoggedOut'] ) ) {
182 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgDBname.'LoggedOut'] );
185 $this->mTouched
= '0'; # Allow any pages to be cached
188 wfProfileOut( $fname );
192 * Used to load user options from a language.
193 * This is not in loadDefault() cause we sometime create user before having
196 function loadDefaultFromLanguage(){
197 $this->mOptions
= User
::getDefaultOptions();
201 * Combine the language default options with any site-specific options
202 * and add the default language variants.
208 function getDefaultOptions() {
210 * Site defaults will override the global/language defaults
212 global $wgContLang, $wgDefaultUserOptions;
213 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptions();
216 * default language setting
218 $variant = $wgContLang->getPreferredVariant();
219 $defOpt['variant'] = $variant;
220 $defOpt['language'] = $variant;
226 * Get a given default option value.
233 function getDefaultOption( $opt ) {
234 $defOpts = User
::getDefaultOptions();
235 if( isset( $defOpts[$opt] ) ) {
236 return $defOpts[$opt];
243 * Get blocking information
245 * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
246 * non-critical checks are done against slaves. Check when actually saving should be done against
249 * Note that even if $bFromSlave is false, the check is done first against slave, then master.
250 * The logic is that if blocked on slave, we'll assume it's either blocked on master or
251 * just slightly outta sync and soon corrected - safer to block slightly more that less.
252 * And it's cheaper to check slave first, then master if needed, than master always.
254 function getBlockedStatus( $bFromSlave = false ) {
255 global $wgIP, $wgBlockCache, $wgProxyList;
257 if ( -1 != $this->mBlockedby
) { return; }
259 $this->mBlockedby
= 0;
263 $block = new Block();
264 $block->forUpdate( $bFromSlave );
265 if ( $block->load( $wgIP , $this->mId
) ) {
266 $this->mBlockedby
= $block->mBy
;
267 $this->mBlockreason
= $block->mReason
;
272 if ( !$this->mBlockedby
) {
273 # Check first against slave, and optionally from master.
274 $block = $wgBlockCache->get( $wgIP, true );
275 if ( !$block && !$bFromSlave )
277 # Not blocked: check against master, to make sure.
278 $wgBlockCache->clearLocal( );
279 $block = $wgBlockCache->get( $wgIP, false );
281 if ( $block !== false ) {
282 $this->mBlockedby
= $block->mBy
;
283 $this->mBlockreason
= $block->mReason
;
288 if ( !$this->mBlockedby
) {
289 if ( array_key_exists( $wgIP, $wgProxyList ) ) {
290 $this->mBlockedby
= wfMsg( 'proxyblocker' );
291 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
297 * Check if user is blocked
298 * @return bool True if blocked, false otherwise
300 function isBlocked( $bFromSlave = false ) {
301 $this->getBlockedStatus( $bFromSlave );
302 if ( 0 === $this->mBlockedby
) { return false; }
307 * Get name of blocker
308 * @return string name of blocker
310 function blockedBy() {
311 $this->getBlockedStatus();
312 return $this->mBlockedby
;
316 * Get blocking reason
317 * @return string Blocking reason
319 function blockedFor() {
320 $this->getBlockedStatus();
321 return $this->mBlockreason
;
325 * Initialise php session
327 function SetupSession() {
328 global $wgSessionsInMemcached, $wgCookiePath, $wgCookieDomain;
329 if( $wgSessionsInMemcached ) {
330 require_once( 'MemcachedSessions.php' );
331 } elseif( 'files' != ini_get( 'session.save_handler' ) ) {
332 # If it's left on 'user' or another setting from another
333 # application, it will end up failing. Try to recover.
334 ini_set ( 'session.save_handler', 'files' );
336 session_set_cookie_params( 0, $wgCookiePath, $wgCookieDomain );
337 session_cache_limiter( 'private, must-revalidate' );
342 * Read datas from session
345 function loadFromSession() {
346 global $wgMemc, $wgDBname;
348 if ( isset( $_SESSION['wsUserID'] ) ) {
349 if ( 0 != $_SESSION['wsUserID'] ) {
350 $sId = $_SESSION['wsUserID'];
354 } else if ( isset( $_COOKIE["{$wgDBname}UserID"] ) ) {
355 $sId = IntVal( $_COOKIE["{$wgDBname}UserID"] );
356 $_SESSION['wsUserID'] = $sId;
360 if ( isset( $_SESSION['wsUserName'] ) ) {
361 $sName = $_SESSION['wsUserName'];
362 } else if ( isset( $_COOKIE["{$wgDBname}UserName"] ) ) {
363 $sName = $_COOKIE["{$wgDBname}UserName"];
364 $_SESSION['wsUserName'] = $sName;
369 $passwordCorrect = FALSE;
370 $user = $wgMemc->get( $key = "$wgDBname:user:id:$sId" );
371 if($makenew = !$user) {
372 wfDebug( "User::loadFromSession() unable to load from memcached\n" );
375 $user->loadFromDatabase();
377 wfDebug( "User::loadFromSession() got from cache!\n" );
380 if ( isset( $_SESSION['wsToken'] ) ) {
381 $passwordCorrect = $_SESSION['wsToken'] == $user->mToken
;
382 } else if ( isset( $_COOKIE["{$wgDBname}Token"] ) ) {
383 $passwordCorrect = $user->mToken
== $_COOKIE["{$wgDBname}Token"];
385 return new User(); # Can't log in from session
388 if ( ( $sName == $user->mName
) && $passwordCorrect ) {
390 if($wgMemc->set( $key, $user ))
391 wfDebug( "User::loadFromSession() successfully saved user\n" );
393 wfDebug( "User::loadFromSession() unable to save to memcached\n" );
395 $user->spreadBlock();
398 return new User(); # Can't log in from session
402 * Load a user from the database
404 function loadFromDatabase() {
405 global $wgCommandLineMode, $wgAnonGroupId, $wgLoggedInGroupId;
406 $fname = "User::loadFromDatabase";
408 # Counter-intuitive, breaks various things, use User::setLoaded() if you want to suppress
409 # loading in a command line script, don't assume all command line scripts need it like this
410 #if ( $this->mDataLoaded || $wgCommandLineMode ) {
411 if ( $this->mDataLoaded
) {
416 $this->mId
= IntVal( $this->mId
);
418 /** Anonymous user */
421 $anong = Group
::newFromId($wgAnonGroupId);
423 wfDebugDieBacktrace("Please update your database schema "
424 ."and populate initial group data from "
425 ."maintenance/archives patches");
426 $anong->loadFromDatabase();
427 $this->mRights
= explode(',', $anong->getRights());
428 $this->mDataLoaded
= true;
430 } # the following stuff is for non-anonymous users only
432 $dbr =& wfGetDB( DB_SLAVE
);
433 $s = $dbr->selectRow( 'user', array( 'user_name','user_password','user_newpassword','user_email',
434 'user_emailauthenticationtimestamp',
435 'user_real_name','user_options','user_touched', 'user_token' ),
436 array( 'user_id' => $this->mId
), $fname );
438 if ( $s !== false ) {
439 $this->mName
= $s->user_name
;
440 $this->mEmail
= $s->user_email
;
441 $this->mEmailAuthenticationtimestamp
= wfTimestamp(TS_MW
,$s->user_emailauthenticationtimestamp
);
442 $this->mRealName
= $s->user_real_name
;
443 $this->mPassword
= $s->user_password
;
444 $this->mNewpassword
= $s->user_newpassword
;
445 $this->decodeOptions( $s->user_options
);
446 $this->mTouched
= wfTimestamp(TS_MW
,$s->user_touched
);
447 $this->mToken
= $s->user_token
;
450 $res = $dbr->select( 'user_groups', array( 'ug_group' ), array( 'ug_user' => $this->mId
) );
452 while($group = $dbr->fetchRow($res)) {
453 $this->mGroups
[] = $group[0];
456 // add the default group for logged in user
457 $this->mGroups
[] = $wgLoggedInGroupId;
459 $this->mRights
= array();
460 // now we merge groups rights to get this user rights
461 foreach($this->mGroups
as $aGroupId) {
462 $g = Group
::newFromId($aGroupId);
463 $g->loadFromDatabase();
464 $this->mRights
= array_merge($this->mRights
, explode(',', $g->getRights()));
467 // array merge duplicate rights which are part of several groups
468 $this->mRights
= array_unique($this->mRights
);
470 $dbr->freeResult($res);
473 $this->mDataLoaded
= true;
476 function getID() { return $this->mId
; }
477 function setID( $v ) {
479 $this->mDataLoaded
= false;
483 $this->loadFromDatabase();
487 function setName( $str ) {
488 $this->loadFromDatabase();
494 * Return the title dbkey form of the name, for eg user pages.
498 function getTitleKey() {
499 return str_replace( ' ', '_', $this->getName() );
502 function getNewtalk() {
503 $fname = 'User::getNewtalk';
504 $this->loadFromDatabase();
506 # Load the newtalk status if it is unloaded (mNewtalk=-1)
507 if( $this->mNewtalk
== -1 ) {
508 $this->mNewtalk
= 0; # reset talk page status
510 # Check memcached separately for anons, who have no
511 # entire User object stored in there.
513 global $wgDBname, $wgMemc;
514 $key = "$wgDBname:newtalk:ip:{$this->mName}";
515 $newtalk = $wgMemc->get( $key );
516 if( is_integer( $newtalk ) ) {
517 $this->mNewtalk
= $newtalk ?
1 : 0;
518 return (bool)$this->mNewtalk
;
522 $dbr =& wfGetDB( DB_SLAVE
);
523 $res = $dbr->select( 'watchlist',
525 array( 'wl_title' => $this->getTitleKey(),
526 'wl_namespace' => NS_USER_TALK
,
527 'wl_user' => $this->mId
,
528 'wl_notificationtimestamp != 0' ),
529 'User::getNewtalk' );
530 if( $dbr->numRows($res) > 0 ) {
533 $dbr->freeResult( $res );
536 $wgMemc->set( $key, $this->mNewtalk
, time() ); // + 1800 );
540 return ( 0 != $this->mNewtalk
);
543 function setNewtalk( $val ) {
544 $this->loadFromDatabase();
545 $this->mNewtalk
= $val;
546 $this->invalidateCache();
549 function invalidateCache() {
550 $this->loadFromDatabase();
551 $this->mTouched
= wfTimestampNow();
552 # Don't forget to save the options after this or
553 # it won't take effect!
556 function validateCache( $timestamp ) {
557 $this->loadFromDatabase();
558 return ($timestamp >= $this->mTouched
);
563 * Will only be salted if $wgPasswordSalt is true
564 * @param string Password.
565 * @return string Salted password or clear password.
567 function addSalt( $p ) {
568 global $wgPasswordSalt;
570 return md5( "{$this->mId}-{$p}" );
576 * Encrypt a password.
577 * It can eventuall salt a password @see User::addSalt()
578 * @param string $p clear Password.
579 * @param string Encrypted password.
581 function encryptPassword( $p ) {
582 return $this->addSalt( md5( $p ) );
585 # Set the password and reset the random token
586 function setPassword( $str ) {
587 $this->loadFromDatabase();
589 $this->mPassword
= $this->encryptPassword( $str );
590 $this->mNewpassword
= '';
593 # Set the random token (used for persistent authentication)
594 function setToken( $token = false ) {
595 global $wgSecretKey, $wgProxyKey, $wgDBname;
597 if ( $wgSecretKey ) {
599 } elseif ( $wgProxyKey ) {
604 $this->mToken
= md5( $wgSecretKey . mt_rand( 0, 0x7fffffff ) . $wgDBname . $this->mId
);
606 $this->mToken
= $token;
611 function setCookiePassword( $str ) {
612 $this->loadFromDatabase();
613 $this->mCookiePassword
= md5( $str );
616 function setNewpassword( $str ) {
617 $this->loadFromDatabase();
618 $this->mNewpassword
= $this->encryptPassword( $str );
621 function getEmail() {
622 $this->loadFromDatabase();
623 return $this->mEmail
;
626 function getEmailAuthenticationtimestamp() {
627 $this->loadFromDatabase();
628 return $this->mEmailAuthenticationtimestamp
;
631 function setEmail( $str ) {
632 $this->loadFromDatabase();
633 $this->mEmail
= $str;
636 function getRealName() {
637 $this->loadFromDatabase();
638 return $this->mRealName
;
641 function setRealName( $str ) {
642 $this->loadFromDatabase();
643 $this->mRealName
= $str;
646 function getOption( $oname ) {
647 $this->loadFromDatabase();
648 if ( array_key_exists( $oname, $this->mOptions
) ) {
649 return $this->mOptions
[$oname];
655 function setOption( $oname, $val ) {
656 $this->loadFromDatabase();
657 if ( $oname == 'skin' ) {
658 # Clear cached skin, so the new one displays immediately in Special:Preferences
659 unset( $this->mSkin
);
661 $this->mOptions
[$oname] = $val;
662 $this->invalidateCache();
665 function getRights() {
666 $this->loadFromDatabase();
667 return $this->mRights
;
670 function addRight( $rname ) {
671 $this->loadFromDatabase();
672 array_push( $this->mRights
, $rname );
673 $this->invalidateCache();
676 function getGroups() {
677 $this->loadFromDatabase();
678 return $this->mGroups
;
681 function setGroups($groups) {
682 $this->loadFromDatabase();
683 $this->mGroups
= $groups;
684 $this->invalidateCache();
688 * A more legible check for non-anonymousness.
689 * Returns true if the user is not an anonymous visitor.
693 function isLoggedIn() {
694 return( $this->getID() != 0 );
698 * A more legible check for anonymousness.
699 * Returns true if the user is an anonymous visitor.
704 return !$this->isLoggedIn();
708 * Check if a user is sysop
709 * Die with backtrace. Use User:isAllowed() instead.
713 wfDebugDieBacktrace("User::isSysop() is deprecated. Use User::isAllowed() instead");
717 function isDeveloper() {
718 wfDebugDieBacktrace("User::isDeveloper() is deprecated. Use User::isAllowed() instead");
722 function isBureaucrat() {
723 wfDebugDieBacktrace("User::isBureaucrat() is deprecated. Use User::isAllowed() instead");
727 * Whether the user is a bot
728 * @todo need to be migrated to the new user level management sytem
731 $this->loadFromDatabase();
733 # Why was this here? I need a UID=0 conversion script [TS]
734 # if ( 0 == $this->mId ) { return false; }
736 return in_array( 'bot', $this->mRights
);
740 * Check if user is allowed to access a feature / make an action
741 * @param string $action Action to be checked (see $wgAvailableRights in Defines.php for possible actions).
742 * @return boolean True: action is allowed, False: action should not be allowed
744 function isAllowed($action='') {
745 $this->loadFromDatabase();
746 return in_array( $action , $this->mRights
);
750 * Load a skin if it doesn't exist or return it
751 * @todo FIXME : need to check the old failback system [AV]
753 function &getSkin() {
755 if ( ! isset( $this->mSkin
) ) {
756 $fname = 'User::getSkin';
757 wfProfileIn( $fname );
759 # get all skin names available
760 $skinNames = Skin
::getSkinNames();
763 $userSkin = $this->getOption( 'skin' );
764 if ( $userSkin == '' ) { $userSkin = 'standard'; }
766 if ( !isset( $skinNames[$userSkin] ) ) {
767 # in case the user skin could not be found find a replacement
772 # if phptal is enabled we should have monobook skin that
773 # superseed the good old SkinStandard.
774 if ( isset( $skinNames['monobook'] ) ) {
775 $fallback[0] = 'MonoBook';
778 if(is_numeric($userSkin) && isset( $fallback[$userSkin]) ){
779 $sn = $fallback[$userSkin];
784 # The user skin is available
785 $sn = $skinNames[$userSkin];
788 # Grab the skin class and initialise it. Each skin checks for PHPTal
789 # and will not load if it's not enabled.
790 require_once( $IP.'/skins/'.$sn.'.php' );
792 # Check if we got if not failback to default skin
793 $className = 'Skin'.$sn;
794 if( !class_exists( $className ) ) {
795 # DO NOT die if the class isn't found. This breaks maintenance
796 # scripts and can cause a user account to be unrecoverable
797 # except by SQL manipulation if a previously valid skin name
798 # is no longer valid.
799 $className = 'SkinStandard';
800 require_once( $IP.'/skins/Standard.php' );
802 $this->mSkin
=& new $className;
803 wfProfileOut( $fname );
809 * @param string $title Article title to look at
813 * Check watched status of an article
814 * @return bool True if article is watched
816 function isWatched( $title ) {
817 $wl = WatchedItem
::fromUserTitle( $this, $title );
818 return $wl->isWatched();
824 function addWatch( $title ) {
825 $wl = WatchedItem
::fromUserTitle( $this, $title );
827 $this->invalidateCache();
831 * Stop watching an article
833 function removeWatch( $title ) {
834 $wl = WatchedItem
::fromUserTitle( $this, $title );
836 $this->invalidateCache();
840 * Clear the user's notification timestamp for the given title.
841 * If e-notif e-mails are on, they will receive notification mails on
842 * the next change of the page if it's watched etc.
844 function clearNotification( $title ) {
845 $userid = $this->getId();
848 $dbw =& wfGetDB( DB_MASTER
);
849 $success = $dbw->update( 'watchlist',
851 'wl_notificationtimestamp' => 0
852 ), array( /* WHERE */
853 'wl_title' => $title->getDBkey(),
854 'wl_namespace' => $title->getNamespace(),
855 'wl_user' => $this->getId()
856 ), 'User::clearLastVisited'
863 * Resets all of the given user's page-change notification timestamps.
864 * If e-notif e-mails are on, they will receive notification mails on
865 * the next change of any watched page.
867 * @param int $currentUser user ID number
870 function clearAllNotifications( $currentUser ) {
871 if( $currentUser != 0 ) {
873 $dbw =& wfGetDB( DB_MASTER
);
874 $success = $dbw->update( 'watchlist',
876 'wl_notificationtimestamp' => 0
877 ), array( /* WHERE */
878 'wl_user' => $currentUser
879 ), 'UserMailer::clearAll'
882 # we also need to clear here the "you have new message" notification for the own user_talk page
883 # This is cleared one page view later in Article::viewUpdates();
889 * @return string Encoding options
891 function encodeOptions() {
893 foreach ( $this->mOptions
as $oname => $oval ) {
894 array_push( $a, $oname.'='.$oval );
896 $s = implode( "\n", $a );
903 function decodeOptions( $str ) {
904 $a = explode( "\n", $str );
905 foreach ( $a as $s ) {
906 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
907 $this->mOptions
[$m[1]] = $m[2];
912 function setCookies() {
913 global $wgCookieExpiration, $wgCookiePath, $wgCookieDomain, $wgDBname;
914 if ( 0 == $this->mId
) return;
915 $this->loadFromDatabase();
916 $exp = time() +
$wgCookieExpiration;
918 $_SESSION['wsUserID'] = $this->mId
;
919 setcookie( $wgDBname.'UserID', $this->mId
, $exp, $wgCookiePath, $wgCookieDomain );
921 $_SESSION['wsUserName'] = $this->mName
;
922 setcookie( $wgDBname.'UserName', $this->mName
, $exp, $wgCookiePath, $wgCookieDomain );
924 $_SESSION['wsToken'] = $this->mToken
;
925 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
926 setcookie( $wgDBname.'Token', $this->mToken
, $exp, $wgCookiePath, $wgCookieDomain );
928 setcookie( $wgDBname.'Token', '', time() - 3600 );
934 * It will clean the session cookie
937 global $wgCookiePath, $wgCookieDomain, $wgDBname, $wgIP;
938 $this->loadDefaults();
939 $this->setLoaded( true );
941 $_SESSION['wsUserID'] = 0;
943 setcookie( $wgDBname.'UserID', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
944 setcookie( $wgDBname.'Token', '', time() - 3600, $wgCookiePath, $wgCookieDomain );
946 # Remember when user logged out, to prevent seeing cached pages
947 setcookie( $wgDBname.'LoggedOut', wfTimestampNow(), time() +
86400, $wgCookiePath, $wgCookieDomain );
951 * Save object settings into database
953 function saveSettings() {
954 global $wgMemc, $wgDBname;
955 $fname = 'User::saveSettings';
957 $dbw =& wfGetDB( DB_MASTER
);
958 if ( ! $this->getNewtalk() ) {
959 # Delete the watchlist entry for user_talk page X watched by user X
960 $dbw->delete( 'watchlist',
961 array( 'wl_user' => $this->mId
,
962 'wl_title' => $this->getTitleKey(),
963 'wl_namespace' => NS_USER_TALK
),
966 # Anon users have a separate memcache space for newtalk
967 # since they don't store their own info. Trim...
968 $wgMemc->delete( "$wgDBname:newtalk:ip:{$this->mName}" );
972 if ( 0 == $this->mId
) { return; }
974 $dbw->update( 'user',
976 'user_name' => $this->mName
,
977 'user_password' => $this->mPassword
,
978 'user_newpassword' => $this->mNewpassword
,
979 'user_real_name' => $this->mRealName
,
980 'user_email' => $this->mEmail
,
981 'user_emailauthenticationtimestamp' => $dbw->timestamp($this->mEmailAuthenticationtimestamp
),
982 'user_options' => $this->encodeOptions(),
983 'user_touched' => $dbw->timestamp($this->mTouched
),
984 'user_token' => $this->mToken
985 ), array( /* WHERE */
986 'user_id' => $this->mId
989 $dbw->set( 'user_rights', 'ur_rights', implode( ',', $this->mRights
),
990 'ur_user='. $this->mId
, $fname );
991 $wgMemc->delete( "$wgDBname:user:id:$this->mId" );
994 $dbw->delete( 'user_groups', array( 'ug_user' => $this->mId
), $fname);
997 foreach ($this->mGroups
as $group) {
998 $dbw->replace( 'user_groups',
999 array(array('ug_user','ug_group')),
1001 'ug_user' => $this->mId
,
1002 'ug_group' => $group
1010 * Checks if a user with the given name exists, returns the ID
1012 function idForName() {
1013 $fname = 'User::idForName';
1016 $s = trim( $this->mName
);
1017 if ( 0 == strcmp( '', $s ) ) return 0;
1019 $dbr =& wfGetDB( DB_SLAVE
);
1020 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), $fname );
1021 if ( $id === false ) {
1028 * Add user object to the database
1030 function addToDatabase() {
1031 $fname = 'User::addToDatabase';
1032 $dbw =& wfGetDB( DB_MASTER
);
1033 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
1034 $dbw->insert( 'user',
1036 'user_id' => $seqVal,
1037 'user_name' => $this->mName
,
1038 'user_password' => $this->mPassword
,
1039 'user_newpassword' => $this->mNewpassword
,
1040 'user_email' => $this->mEmail
,
1041 'user_emailauthenticationtimestamp' => $dbw->timestamp($this->mEmailAuthenticationtimestamp
),
1042 'user_real_name' => $this->mRealName
,
1043 'user_options' => $this->encodeOptions(),
1044 'user_token' => $this->mToken
1047 $this->mId
= $dbw->insertId();
1048 $dbw->insert( 'user_rights',
1050 'ur_user' => $this->mId
,
1051 'ur_rights' => implode( ',', $this->mRights
)
1055 foreach ($this->mGroups
as $group) {
1056 $dbw->insert( 'user_groups',
1058 'ug_user' => $this->mId
,
1059 'ug_group' => $group
1065 function spreadBlock() {
1067 # If the (non-anonymous) user is blocked, this function will block any IP address
1068 # that they successfully log on from.
1069 $fname = 'User::spreadBlock';
1071 wfDebug( "User:spreadBlock()\n" );
1072 if ( $this->mId
== 0 ) {
1076 $userblock = Block
::newFromDB( '', $this->mId
);
1077 if ( !$userblock->isValid() ) {
1081 # Check if this IP address is already blocked
1082 $ipblock = Block
::newFromDB( $wgIP );
1083 if ( $ipblock->isValid() ) {
1084 # Just update the timestamp
1085 $ipblock->updateTimestamp();
1089 # Make a new block object with the desired properties
1090 wfDebug( "Autoblocking {$this->mName}@{$wgIP}\n" );
1091 $ipblock->mAddress
= $wgIP;
1092 $ipblock->mUser
= 0;
1093 $ipblock->mBy
= $userblock->mBy
;
1094 $ipblock->mReason
= wfMsg( 'autoblocker', $this->getName(), $userblock->mReason
);
1095 $ipblock->mTimestamp
= wfTimestampNow();
1096 $ipblock->mAuto
= 1;
1097 # If the user is already blocked with an expiry date, we don't
1098 # want to pile on top of that!
1099 if($userblock->mExpiry
) {
1100 $ipblock->mExpiry
= min ( $userblock->mExpiry
, Block
::getAutoblockExpiry( $ipblock->mTimestamp
));
1102 $ipblock->mExpiry
= Block
::getAutoblockExpiry( $ipblock->mTimestamp
);
1110 function getPageRenderingHash() {
1113 return $this->mHash
;
1116 // stubthreshold is only included below for completeness,
1117 // it will always be 0 when this function is called by parsercache.
1119 $confstr = $this->getOption( 'math' );
1120 $confstr .= '!' . $this->getOption( 'stubthreshold' );
1121 $confstr .= '!' . $this->getOption( 'editsection' );
1122 $confstr .= '!' . $this->getOption( 'editsectiononrightclick' );
1123 $confstr .= '!' . $this->getOption( 'date' );
1124 $confstr .= '!' . $this->getOption( 'numberheadings' );
1125 $confstr .= '!' . $this->getOption( 'language' );
1126 // add in language specific options, if any
1127 $extra = $wgContLang->getExtraHashOptions();
1130 $this->mHash
= $confstr;
1134 function isAllowedToCreateAccount() {
1135 global $wgWhitelistAccount;
1138 if (!$wgWhitelistAccount) { return 1; }; // default behaviour
1139 foreach ($wgWhitelistAccount as $right => $ok) {
1140 $userHasRight = (!strcmp($right, 'user') ||
in_array($right, $this->getRights()));
1141 $allowed |
= ($ok && $userHasRight);
1147 * Set mDataLoaded, return previous value
1148 * Use this to prevent DB access in command-line scripts or similar situations
1150 function setLoaded( $loaded ) {
1151 return wfSetVar( $this->mDataLoaded
, $loaded );
1155 * Get this user's personal page title.
1160 function getUserPage() {
1161 return Title
::makeTitle( NS_USER
, $this->mName
);
1165 * Get this user's talk page title.
1170 function getTalkPage() {
1171 $title = $this->getUserPage();
1172 return $title->getTalkPage();
1178 function getMaxID() {
1179 $dbr =& wfGetDB( DB_SLAVE
);
1180 return $dbr->selectField( 'user', 'max(user_id)', false );
1184 * Determine whether the user is a newbie. Newbies are either
1185 * anonymous IPs, or the 1% most recently created accounts.
1186 * Bots and sysops are excluded.
1187 * @return bool True if it is a newbie.
1189 function isNewbie() {
1190 return $this->mId
> User
::getMaxID() * 0.99 && !$this->isSysop() && !$this->isBot() ||
$this->getID() == 0;
1194 * Check to see if the given clear-text password is one of the accepted passwords
1195 * @param string $password User password.
1196 * @return bool True if the given password is correct otherwise False.
1198 function checkPassword( $password ) {
1200 $this->loadFromDatabase();
1202 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
1204 } elseif( $wgAuth->strict() ) {
1205 /* Auth plugin doesn't allow local authentication */
1208 $ep = $this->encryptPassword( $password );
1209 if ( 0 == strcmp( $ep, $this->mPassword
) ) {
1211 } elseif ( ($this->mNewpassword
!= '') && (0 == strcmp( $ep, $this->mNewpassword
)) ) {
1212 $this->mEmailAuthenticationtimestamp
= wfTimestampNow();
1213 $this->mNewpassword
= ''; # use the temporary one-time password only once: clear it now !
1214 $this->saveSettings();
1216 } elseif ( function_exists( 'iconv' ) ) {
1217 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
1218 # Check for this with iconv
1219 $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252', $password ) );
1220 if ( 0 == strcmp( $cp1252hash, $this->mPassword
) ) {
1228 * Initialize (if necessary) and return a session token value
1229 * which can be used in edit forms to show that the user's
1230 * login credentials aren't being hijacked with a foreign form
1233 * @param mixed $salt - Optional function-specific data for hash.
1234 * Use a string or an array of strings.
1238 function editToken( $salt = '' ) {
1239 if( !isset( $_SESSION['wsEditToken'] ) ) {
1240 $token = dechex( mt_rand() ) . dechex( mt_rand() );
1241 $_SESSION['wsEditToken'] = $token;
1243 $token = $_SESSION['wsEditToken'];
1245 if( is_array( $salt ) ) {
1246 $salt = implode( '|', $salt );
1248 return md5( $token . $salt );
1252 * Check given value against the token value stored in the session.
1253 * A match should confirm that the form was submitted from the
1254 * user's own login session, not a form submission from a third-party
1257 * @param string $val - the input value to compare
1258 * @param string $salt - Optional function-specific data for hash
1262 function matchEditToken( $val, $salt = '' ) {
1263 return ( $val == $this->editToken( $salt ) );